Sourced from python-json-logger's releases.

3.2.0

3.2.0 - 2024-12-11

Changed

• pythonjsonlogger.[ORJSON,MSGSPEC]_AVAILABLE no longer imports the respective package when determining availability.
• pythonjsonlogger.[orjson,msgspec] now throws a pythonjsonlogger.exception.MissingPackageError when required libraries are not available. These contain more information about what is missing whilst still being an ImportError.
• defaults parameter is no longer ignored and now conforms to the standard library. Setting a defaults dictionary will add the specified keys if the those keys do not exist in a record or weren't passed by the extra parameter when logging a message.
• typing_extensions is only installed on Python version < 3.10.
• Support Python 3.13
  • msgspec has only been tested against pre-release versions.

Thanks @​cjwatson and @​bharel

v3.1.0

3.1.0 - 2023-05-28

This splits common funcitonality out to allow supporting other JSON encoders. Although this is a large refactor, backwards compatibility has been maintained.

Added

• pythonjsonlogger.core - more details below.
• pythonjsonlogger.defaults module that provides many functions for handling unsupported types.
• Orjson encoder support via pythonjsonlogger.orjson.OrjsonFormatter with the following additions:
  • bytes are URL safe base64 encoded.
  • Exceptions are "pretty printed" using the exception name and message e.g. "ValueError: bad value passed"
  • Enum values use their value, Enum classes now return all values as a list.
  • Tracebacks are supported
  • Classes (aka types) are support
  • Will fallback on __str__ if available, else __repr__ if available, else will use __could_not_encode__
• MsgSpec encoder support via pythonjsonlogger.msgspec.MsgspecFormatter with the following additions:
  • Exceptions are "pretty printed" using the exception name and message e.g. "ValueError: bad value passed"
  • Enum classes now return all values as a list.
  • Tracebacks are supported
  • Classes (aka types) are support
  • Will fallback on __str__ if available, else __repr__ if available, else will use __could_not_encode__
  • Note: msgspec only supprts enum values of type int or str jcrist/msgspec#680

Changed

• pythonjsonlogger.jsonlogger has been moved to pythonjsonlogger.json with core functionality moved to pythonjsonlogger.core.
• pythonjsonlogger.core.BaseJsonFormatter properly supports all logging.Formatter arguments:
  • fmt is unchanged.
  • datefmt is unchanged.
  • style can now support non-standard arguments by setting validate to False
  • validate allows non-standard style arguments or prevents calling validate on standard style arguments.
  • default is ignored.
• pythonjsonlogger.json.JsonFormatter default encodings changed:
  • bytes are URL safe base64 encoded.
  • Exception formatting detected using BaseException instead of Exception. Now "pretty prints" the exception using the exception name and message e.g. "ValueError: bad value passed"
  • Dataclasses are now supported
  • Enum values now use their value, Enum classes now return all values as a list.
  • Will fallback on __str__ if available, else __repr__ if available, else will use __could_not_encode__

... (truncated)

Sourced from python-json-logger's changelog.

3.2.0 - 2024-12-11

Changed

• pythonjsonlogger.[ORJSON,MSGSPEC]_AVAILABLE no longer imports the respective package when determining availability.
• pythonjsonlogger.[orjson,msgspec] now throws a pythonjsonlogger.exception.MissingPackageError when required libraries are not available. These contain more information about what is missing whilst still being an ImportError.
• defaults parameter is no longer ignored and now conforms to the standard library. Setting a defaults dictionary will add the specified keys if the those keys do not exist in a record or weren't passed by the extra parameter when logging a message.
• typing_extensions is only installed on Python version < 3.10.
• Support Python 3.13
  • msgspec has only been tested against pre-release versions.

Thanks @​cjwatson and @​bharel

3.1.0 - 2023-05-28

This splits common funcitonality out to allow supporting other JSON encoders. Although this is a large refactor, backwards compatibility has been maintained.

Added

• pythonjsonlogger.core - more details below.
• pythonjsonlogger.defaults module that provides many functions for handling unsupported types.
• Orjson encoder support via pythonjsonlogger.orjson.OrjsonFormatter with the following additions:
  • bytes are URL safe base64 encoded.
  • Exceptions are "pretty printed" using the exception name and message e.g. "ValueError: bad value passed"
  • Enum values use their value, Enum classes now return all values as a list.
  • Tracebacks are supported
  • Classes (aka types) are support
  • Will fallback on __str__ if available, else __repr__ if available, else will use __could_not_encode__
• MsgSpec encoder support via pythonjsonlogger.msgspec.MsgspecFormatter with the following additions:
  • Exceptions are "pretty printed" using the exception name and message e.g. "ValueError: bad value passed"
  • Enum classes now return all values as a list.
  • Tracebacks are supported
  • Classes (aka types) are support
  • Will fallback on __str__ if available, else __repr__ if available, else will use __could_not_encode__
  • Note: msgspec only supprts enum values of type int or str jcrist/msgspec#680

Changed

• pythonjsonlogger.jsonlogger has been moved to pythonjsonlogger.json with core functionality moved to pythonjsonlogger.core.
• pythonjsonlogger.core.BaseJsonFormatter properly supports all logging.Formatter arguments:
  • fmt is unchanged.
  • datefmt is unchanged.
  • style can now support non-standard arguments by setting validate to False
  • validate allows non-standard style arguments or prevents calling validate on standard style arguments.
  • default is ignored.
• pythonjsonlogger.json.JsonFormatter default encodings changed:
  • bytes are URL safe base64 encoded.
  • Exception formatting detected using BaseException instead of Exception. Now "pretty prints" the exception using the exception name and message e.g. "ValueError: bad value passed"
  • Dataclasses are now supported
  • Enum values now use their value, Enum classes now return all values as a list.
  • Will fallback on __str__ if available, else __repr__ if available, else will use __could_not_encode__
• Renaming fields now preserves order (#7) and ignores missing fields (#6).
• Documentation

... (truncated)

• c6c8041 Release 3.2.0
• e5d03eb [docs.contributing] Add PSF affiliation clarification
• 2548e3a [pyproject] Support Python 3.13 (#23)
• 2ed6762 [docs] Add PR authors to change log
• f266f86 Use defaults argument (#26)
• 2f773cb Restrict typing_extensions requirement to < 3.10 (#28)
• a1daea2 Improve handling of optional packages (#27)
• bc807f5 [docs] Expand coobook, cleanup references
• ee2c128 Add CODE_OF_CONDUCT.md symlink
• e2b40e4 Release 3.1.0
• Additional commits viewable in compare view

You can trigger Dependabot actions by commenting on this PR:

• @dependabot rebase will rebase this PR
• @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
• @dependabot merge will merge this PR after your CI passes on it
• @dependabot squash and merge will squash and merge this PR after your CI passes on it
• @dependabot cancel merge will cancel a previously requested merge and block automerging
• @dependabot reopen will reopen this PR if it is closed
• @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
• @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
• @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
• @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)